Detect __pyx_capi__ changes in testing #1067
Conversation
|
Auto-sync is disabled for ready for review pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
|
/ok to test |
|
|
Would this have caught the issues mentioned in #1030? |
Yes, symbols would have been removed from |
|
This theoretically would detect the change as described here. It's basically reverse engineering what Cython does when it does its custom "dynamic linking". I would have liked to have tested it directly, but it's surprisingly hard to build 11.7 today, and there don't seem to be any wheels or conda packages available. |
|
/ok to test |
leofang
added
P1
|
It occurred to me that the main downside of this approach (that you have to update the But it's a larger discussion to have to move to a different branch model, so maybe we table this for now? (I suspect @cpcloud has opinions about branching models, etc.) |
|
This seems to have stalled. Should we close it and accept that we won't be able to catch C ABI breakage in all cases and that we're prioritizing ease of development in this case? |
|
My opinion is that for a lot of good reasons we shouldn't be releasing from main. Once we have made that change, it would make sense to come back to this and only activate the test on maintenance branches. I'll close for now. |
|
Relevant: #1199 |
|
FWIW I don't have too many opinions on branch releases, having not worked on many teams that have released software that way. Definitely open to alternative models there! |
Removed preview folders for the following PRs: - PR #1067
|
Let me reopen this
|
|
Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually. Contributors can view more details about this message here. |
4 participants
As a way of detecting changes in "Cython ABI" (which is loosely defined, see #1030), this adds the contents of the
__pyx_capi__dictionary to JSON files in the repository, and then adds a unit test to detect any changes.I think this may be useful as a first defense against ABI changes, however it's not a complete solution. This can not detect changes in structs or enums used across Cython modules.
There is also the risk of annoyance any time new functions are added, which is a completely "ABI safe" operation, but we need to update the baselines in order to detect unsafe operations (deletions) in the future. An alternative approach might be to download a baseline wheel and compare the ABI against it directly -- that could be done in CI but would be harder to run locally.
Closes #1030